GitHub

您所在的位置：网站首页 › fetch to › GitHub

GitHub

2023-03-14 15:42| 来源: 网络整理| 查看: 265

nostr-fetch

A utility library that allows JS/TS apps to effortlessly fetch past events from Nostr relays.

Installation # npm npm install nostr-fetch # yarn yarn add nostr-fetch # pnpm pnpm add nostr-fetch Usage

See codes under examples directory.

Note

You must install and import websocket-polyfill to use this on Node.js.

import 'websocket-polyfill';

You can run examples by following the steps (using npm for example):

# first, install dependencies npm install # then, execute example npm run exec-ts examples/fetchAll.ts # getProfiles.ts takes a hex pubkey as an argument npm run exec-ts examples/getProfiles.ts API class NostrFetcher

The entry point of Nostr events fetching.

It manages connections to Nostr relays under the hood. It is recommended to reuse single NostrFetcher instance in entire app.

NostrFetcher#allEventsIterator() public async allEventsIterator( relayUrls: string[], filters: FetchFilter[], timeRangeFilter: FetchTimeRangeFilter, options: FetchOptions = {} ): Promise

Returns an async iterable of all events matching the filters from Nostr relays specified by the array of URLs.

You can iterate over events using for-await-of loop.

const fetcher = new NostrFetcher(); const events = await fetcher.allEventsIterator([...], [{...}], {...}); for await (const ev of events) { // process events }

Note

There are no guarantees about the order of returned events. Especially, events are not necessarily ordered in "newest to oldest" order.

NostrFetcher#fetchAllEvents() public async fetchAllEvents( relayUrls: string[], filters: FetchFilter[], timeRangeFilter: FetchTimeRangeFilter, options: FetchAllOptions = {} ): Promise

Fetches all events matching the filters from Nostr relays specified by the array of URLs, and collect them into an array.

If sort: true is specified in options, events in the resulting array will be sorted in "newest to oldest" order.

Note

There are no guarantees about the order of returned events if sort options is not specified.

NostrFetcher#fetchLatestEvents() public async fetchLatestEvents( relayUrls: string[], filters: FetchFilter[], limit: number, options: FetchOptions = {} ): Promise

Fetches latest up to limit events matching the filters from Nostr relays specified by the array of URLs.

Events in the result will be sorted in "newest to oldest" order.

NostrFetcher#fetchLastEvent() public async fetchLastEvent( relayUrls: string[], filters: FetchFilter[], options: FetchOptions = {} ): Promise

Fetches the last event matching the filters from Nostr relays specified by the array of URLs.

Returns undefined if no event matching the filters exists in any relay.

NostrFetcher#shutdown() public shutdown(): void

Closes all the connections to relays and clean up the internal relay pool.

【本文地址】

GitHub

GitHub

今日新闻

推荐新闻